GetIconRefVariant

GetIconRefVariant
Header:	Icons.h		Carbon status:	Under Evaluation

Specifies a transformation for a given IconRef.

IconRef GetIconRefVariant (
    IconRef inIconRef, 
    OSType inVariant, 
    IconTransformType *outTransform
);

inIconRef

A value to be tested.

inVariant

A four-character value. You specify a variant by passing one of the constants defined by the enumeration described in “Icon Variant Constants”. These constants are as follows:

kTileIconVariant specifies a tiled icon.

kRolloverIconVariant specifies a rollover icon.

kDropIconVariant specifies a drop target icon.

kOpenIconVariant specifies an open icon.

kOpenDropIconVariant specifies a open drop target icon.

outTransform

On completion, this points to a transformation type that you pass to the function PlotIconRef for purposes of hit-testing.

function result: An IconRef value that you pass to the function PlotIconRef for purposes of hit-testing.

DISCUSSION

Icon variants give you a simple way to indicate a temporary change of state by changing an icon’s appearance. For example, if you specify the kDropIconVariant value when the user drags over a valid drop target, the GetIconVariant function provides the appropriate data for you to plot the variant with the function PlotIconRef.

AVAILABILITY

Under evaluation for Carbon. Available in CarbonLib 1.0 and later. Exported by CarbonLib 1.0 and later.